home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / wb-tools / system-tools / manual / manual.doc_e < prev    next >
Encoding:
Text File  |  1995-03-09  |  8.2 KB  |  226 lines
  1.  
  2.             Short description of Manual 1.00
  3.             ================================
  4.  
  5.                   (by Thomas Egeter)
  6.  
  7.  
  8.  
  9.  
  10. Copyright and Disclaimer
  11. ------------------------
  12.  
  13.     Copyright (c) 1994, Thomas Egeter, All Rights Reserved
  14.  
  15.     You may freely use and distribute this program under the following
  16.     conditions:
  17.  
  18.     1) No modifications are made into the program or this documentation
  19.        However, you are allowed to compress all the files into an archive
  20.        for distribution.
  21.  
  22.     2) All the files are spread together.
  23.  
  24.     3) No money (other than nominal copying fees) is charged for its
  25.        distribution.
  26.  
  27.     4) Everybody using this Manual program (even occasionally) is liable
  28.        to send a postcard to the author's address (see below).
  29.  
  30.     THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  31.     EXPRESSED OR IMPLIED. THE AUTHOR WILL NOT BE LIABLE FOR ANY DAMAGES,
  32.     DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL, RESULTING FROM THE USE
  33.     OF THE PROGRAM. THE ENTIRE RISK AS TO THE USE OF THIS PROGRAM IS ASSUMED
  34.     BY THE USER.
  35.  
  36.  
  37. Introduction
  38. ------------
  39.  
  40.     Manual is a tool which helps you to find the manuals of all those programs
  41.     which have gathered on your harddisk in course of time. The doc files
  42.     should be placed in a few subdirectories (or else you have to type
  43.     hundreds of paths in Manual's ToolTypes).
  44.     Manual can work in three modes:
  45.         - CLI mode
  46.             Manual is started from the (you guess it ? Greaat :-) CLI. The
  47.             programnames are passed to Manual as parameters on the command-
  48.             line.
  49.         - Workbench mode
  50.             the programnames are passed with multiselection. Click on
  51.             Manual's icon, press and hold the shift-button and doubleclick
  52.             on a program's icon.
  53.         - AppIcon mode
  54.             doubleclick Manual's icon. An appicon appears. Drop any program-
  55.             icon on this appicon and Manual will search for the right manual.
  56.     Search paths, display programs and other settings are read from Manual's
  57.     icon file (even in CLI mode!). Manual always must have an icon. Else
  58.     Manual uses default settings which may be useless to you.
  59.  
  60.  
  61. Getting started
  62. ---------------
  63.  
  64.     1) from the CLI
  65.  
  66.         a)  Manual program1 program2 program3 ... programN
  67.             searches for the doc-files for program1, program2 up to programN
  68.             and displays them when found.
  69.  
  70.         b)  Manual -appicon
  71.             puts an appicon on the Workbench. To detach from the initial CLI
  72.             you have to use:
  73.             Manual >NIL: <NIL: -appicon
  74.  
  75.     2) from Workbench
  76.  
  77.         a)  Doubleclick
  78.             doubleclicking on Manual's icon puts an appicon on the workbench.
  79.             To look for a program documentation just drop the program's icon
  80.             on Manual's appicon.
  81.  
  82.         b)  Multiselect
  83.             clicking on Manual's icon, pressing the shift-key and, while
  84.             pressing, clicking on other programs' icons and doubleclicking
  85.             on the last icon will view the manuals of these programs.
  86.  
  87.     The search-pathes for the manuals is looked up in Manual's icon. If there
  88.     isn't the right ToolType a default path will be used.
  89.  
  90.  
  91. ToolTypes
  92. ---------
  93.  
  94.     1)  PFAD#=path,suffix,display_program
  95.  
  96.         #       means a number.
  97.                 Use numbers starting from 1 up to the number of paths you
  98.                 want to use. Manual looks first for PFAD1 then for PFAD2
  99.                 and so on until such a ToolType doesn't exist. If e.g.
  100.                 PFAD3 does _not_ exist but PFAD4 does, then PFAD4 will
  101.                 never be recognised.                
  102.  
  103.         path    the path which will be used for searching the manuals.
  104.                 Must be terminated by ':' or '/'.
  105.                 Example:    Docs:Guides/
  106.  
  107.         suffix  should be appended to the program's name to get the
  108.                 name of the program's manual.
  109.                 Example:    the suffix is '.guide'; is the program's
  110.                             name 'MuchMore' then a manual named
  111.                             'MuchMore.guide' will be searched.
  112.  
  113.         display_program   path and name of the program which should be
  114.                 used to display the manual.
  115.                 Example:    SYS:Utilities/AmigaGuide
  116.  
  117.         Path, suffix and display_program have to be separated by commas.
  118.  
  119.         Full example:
  120.                   PFAD1=Docs:,.doc,SYS:Utilities/More
  121.                   PFAD2=Docs:Guides/,.guide,SYS:Utilities/AmigaGuide
  122.                   PFAD3=Docs:DVI/,.dvi,TeX:ShowDVI
  123.  
  124.         Default:  PFAD1=Docs:,.doc,SYS:Utilities/More
  125.  
  126.     2)  APPICON_X   the horizontal position of Manual's appicon.
  127.                     Example:    APPICON_X=100
  128.  
  129.     3)  APPICON_Y   the vertical position of Manual's appicon.
  130.                     Example:    APPICON_Y=22
  131.  
  132.     4)  APPNAME     the name which appears under the appicon.
  133.                     Example:    APPNAME=man
  134.                     Default:    the name with which Manual was started
  135.  
  136.     5)  APPICON     APPICON=Default
  137.                         Manual's icon will be used as appicon.
  138.                     APPICON=Intern
  139.                         an internal icon (made by Volker Milsch) will be used
  140.                         as Manual's appicon.
  141.                     APPICON=Extern
  142.                         any icon you wish can be used as Manual's appicon. You
  143.                         have to use the ToolType 'ICONFILE' to tell Manual
  144.                         which icon you want to use.
  145.  
  146.     6)  ICONFILE    path and name of an icon (without '.info'). Gets used as
  147.                     appicon if the ToolType 'APPICON=Extern' is set.
  148.                     Example:    ICONFILE=RAM:Disk
  149.  
  150.     7)  MELDUNG     tells Manual wether to show a message or not when a
  151.                     program's manual can't be found.
  152.                     Examples:   MELDUNG=Aus     -> no message
  153.                                 MELDUNG=Ein     -> message allowed
  154.                     Default:    MELDUNG=Ein
  155.  
  156.     8)  REQUESTER   tells Manual wether system requesters like 'Please insert
  157.                     volume XXX ...' should appear or not.
  158.                     Examples:   REQUESTER=Aus   -> no system requesters
  159.                                 REQUESTER=Ein   -> system requesters allowed
  160.                     Default:    Requester=Ein
  161.  
  162.     9)  DONOTWAIT   use this if you put Manual in your WBStartup-drawer.
  163.                     It tells Workbench not to wait until Manual has finished.
  164.  
  165.  
  166. How does Manual search for docs ?
  167. ---------------------------------
  168.  
  169.     Manual looks at PFAD1-ToolType, appends the suffix to the name of the
  170.     program and searches in the given path for a file with this name. If
  171.     found it will be displayed using the given display program. If not
  172.     found Manual will take the next path, PFAD2, ... and so on.
  173.     Warning: If there are more manuals for one program (e.g. MuchMore.doc
  174.              _and_ MuchMore.guide) then only the first one which was found
  175.              will be displayed.
  176.  
  177.  
  178. Limitations
  179. -----------
  180.  
  181.     -   Manual needs at least AmigaOS 2.0
  182.     -   this version only has German texts
  183.     -   there's no possibility to change Manual's behaviour 'on the fly' when
  184.         using appicon mode (look at the Prefs-button: it's intended to start a
  185.         GUI for changing all options. Send me a nice email/postcard if you
  186.         want to see this feature ;-)
  187.  
  188.  
  189. To Do (or not to do :-)
  190. -----------------------
  191.  
  192.     - GUI for changing the search paths
  193.     - turn this manual in an AmigaGuide-document
  194.     - support of locale.library (with different language cataloges)
  195.     - remove bugs (bugs? Are there any bugs left? Tell me if you found them)
  196.  
  197.  
  198. Author
  199. ------
  200.  
  201.     I can be reached under ...
  202.  
  203.         email:      fh0015@rfhs1012.fh.uni-regensburg.de
  204.  
  205.         IRC:        Diogenes
  206.  
  207.         snail-mail: Thomas Egeter
  208.                     Am Alten Dorf 31
  209.                     D - 92637 Weiden
  210.                     Germany
  211.  
  212.  
  213. Thanx to
  214. --------
  215.  
  216.     Douglas Adams       for the 'Hitchhiker's Guide'
  217.  
  218.     Volker Milsch       for his pretty icon. You can admire it as Manual's
  219.                         internal icon.
  220.                         for his comments while beta-testing ("It reacts
  221.                         somehow funny, if ...")
  222.  
  223.     Reinhard            for his hint with a 'pseudo'-window
  224.  
  225.     Rotti               for his beta-testing
  226.